BOT UX API
Get topupHistory
URL
http://[host]:[port]/bot-ux/v1/{businessId}/subscribers/{serviceNo}/histories/topupCommon Parameters
Base URI parameters and headers are common to all the resources as part of account management Biz API, listed below with details.
URI Parameter
| Name | Type | Description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code ("PA","JM","TT","BB","BS","CW","LC","VC","AG") identifying the business unit. | M |
| serviceNo | string | Service number or subscriber number(for PA and CWC Bu's(Ex: "JM","TT","BB","BS","CW","LC","VC","AG")) | M |
Headers
| name | value | description | required |
|---|---|---|---|
| X-Correlation-ID | string | This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b | M |
| lob | String | The Line of Business Identifier currently available are: Enum: PREPAID, POSTPAID,FIXED Note : Mobile users: PREPAID, POSTPAID Fixed users : FIXED | M |
Response header
| Name | Type | M/O | Description |
|---|---|---|---|
| X-Total-Count | string | M | Total results |
Security Headers
| Name | Type | M/O | Description |
|---|---|---|---|
| client_id | string | M | Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 438837c439924cbca0e96113d9abded0 |
| client_secret | string | M | Client secret value for Client Id Enforcement policy. Environment Specific Value, eg: 8ABb78e206384B33aE08a61f5bDfd393 |
Query Param
| name | type | description | requireM |
|---|---|---|---|
| startDate | datetime | To retrieve the topupHistory placed before this date Ex: 2021-09-26T00:00:00 | M |
| endDate | datetime | To retrieve the topupHistory placed after this date Ex: 2021-12-26T00:00:00 | M |
| limit | Integer | maximum no of records to fetch Ex: 3 | O |
| @type | String | Fetch the Balance Action resource for all topup balances Enum values: TopupBalance AdjustBalance ReserveBalance TransferBalance | M |
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
TMF Response for getTopupHistory
JM Success Response for v1 and v2
[
{
"@type": "TopupBalance",
"description": "CWC_ESB,1,1,123456789:rdOnlineInMarket,WEB,JAM",
"confirmationDate": "2022-11-08T00:25:18.000-05:00",
"@baseType": "Action",
"amount": {
"amount": 1.00,
"units": "JMD"
},
"product": [
{
"id": "32970253",
"name": "serviceInternalId"
}
],
"partyAccount": {
"id": "32795117",
"name": "owningAccountInternalId"
},
"channel": {
"id": "11006",
"name": "limeware"
},
"logicalResource": [
{
"@type": "MSISDN",
"value": "18765544355"
}
],
"relatedParty": [
{
"id": "-1",
"name": "batchNumber"
},
{
"id": "11006",
"name": "rechargeId"
},
{
"id": "8347003",
"name": "rechargeId2"
},
{
"id": "NON VOUCHER",
"name": "cardNumber"
},
{
"id": "",
"name": "serialNumber"
},
{
"id": "1.0",
"name": "currencyConvRate"
}
],
"impactedBucket": [
{
"impactedBucketItem": [
{
"id": "1",
"@baseType": "BucketBalance",
"name": "primary balance",
"usageType": "Currency",
"amount": {
"amount": 600.31,
"units": "JMD"
},
"validFor": {
"endDateTime": "2022-11-29T00:00:00.000-05:00"
}
},
{
"id": "32",
"@baseType": "BucketBalance",
"name": "Roaming Data",
"usageType": "MB",
"amount": {
"amount": 0.00,
"units": "MB"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "2",
"@baseType": "BucketBalance",
"name": "Text Messages",
"usageType": "SMS",
"amount": {
"amount": 0.00,
"units": "SMS"
},
"validFor": {
"endDateTime": "2017-06-04T00:00:00.000-05:00"
}
},
{
"id": "33",
"@baseType": "BucketBalance",
"name": "IDD Credit Balance",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "3",
"@baseType": "BucketBalance",
"name": "International Minutes",
"usageType": "mins",
"amount": {
"amount": 72000.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2022-11-05T10:42:47.000-05:00"
}
},
{
"id": "4",
"@baseType": "BucketBalance",
"name": "Free LIME text",
"usageType": "SMS",
"amount": {
"amount": 0.00,
"units": "SMS"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "5",
"@baseType": "BucketBalance",
"name": "Local LIME Only Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-06-14T00:00:00.000-05:00"
}
},
{
"id": "6",
"@baseType": "BucketBalance",
"name": "Text Messages",
"usageType": "SMS",
"amount": {
"amount": 0.00,
"units": "SMS"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "7",
"@baseType": "BucketBalance",
"name": "Points",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2017-06-14T00:00:00.000-05:00"
}
},
{
"id": "8",
"@baseType": "BucketBalance",
"name": "Off Net",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "9",
"@baseType": "BucketBalance",
"name": "LIME Faves",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "10",
"@baseType": "BucketBalance",
"name": "Bonus",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "13",
"@baseType": "BucketBalance",
"name": "Double Bubble Bonus",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "14",
"@baseType": "BucketBalance",
"name": "LIME Text Messages",
"usageType": "SMS",
"amount": {
"amount": 0.00,
"units": "SMS"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "17",
"@baseType": "BucketBalance",
"name": "FMC_Balance",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "16",
"@baseType": "BucketBalance",
"name": "Roaming Text Messages",
"usageType": "SMS",
"amount": {
"amount": 0.00,
"units": "SMS"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "19",
"@baseType": "BucketBalance",
"name": "Flow Caribbean Voice Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "18",
"@baseType": "BucketBalance",
"name": "Local LIME Only Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "20",
"@baseType": "BucketBalance",
"name": "Flow Lend Balance",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2032-09-26T02:31:26.000-05:00"
}
},
{
"id": "22",
"@baseType": "BucketBalance",
"name": "Anywhere Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "25",
"@baseType": "BucketBalance",
"name": "Roaming Voice Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "27",
"@baseType": "BucketBalance",
"name": "Loyalty Bonus",
"usageType": "Currency",
"amount": {
"amount": 13732.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2018-12-24T17:34:02.000-05:00"
}
},
{
"id": "28",
"@baseType": "BucketBalance",
"name": "Anywhere Local Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "30",
"@baseType": "BucketBalance",
"name": "International Minutes",
"usageType": "mins",
"amount": {
"amount": 1800.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2018-11-24T12:56:02.000-05:00"
}
},
{
"id": "36",
"@baseType": "BucketBalance",
"name": "AllNetMinutes",
"usageType": "mins",
"amount": {
"amount": 4611.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2019-02-17T13:22:30.000-05:00"
}
},
{
"id": "35",
"@baseType": "BucketBalance",
"name": "Anywhere Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2018-09-24T00:00:00.000-05:00"
}
},
{
"id": "38",
"@baseType": "BucketBalance",
"amount": {
"amount": 0.00
},
"validFor": {
"endDateTime": "2018-10-23T00:00:00.000-05:00"
}
},
{
"id": "39",
"@baseType": "BucketBalance",
"name": "POST_VOICE",
"usageType": "mins",
"amount": {
"amount": 36000.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2022-10-28T06:03:20.000-05:00"
}
},
{
"id": "40",
"@baseType": "BucketBalance",
"name": "FMC_Balance",
"usageType": "Currency",
"amount": {
"amount": 12600.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2022-10-17T03:44:49.000-05:00"
}
},
{
"id": "41",
"@baseType": "BucketBalance",
"name": "Unlimited SMS",
"usageType": "SMS",
"amount": {
"amount": 200.00,
"units": "SMS"
},
"validFor": {
"endDateTime": "2022-10-28T06:03:20.000-05:00"
}
},
{
"id": "43",
"@baseType": "BucketBalance",
"amount": {
"amount": 0.00
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
}
],
"@type": "BalanceHistory"
},
{
"impactedBucketItem": [
{
"id": "2",
"@baseType": "BucketBalance",
"name": "Text Messages",
"usageType": "SMS",
"amount": {
"amount": 1.00,
"units": "SMS"
}
},
{
"id": "3",
"@baseType": "BucketBalance",
"name": "International Minutes",
"usageType": "mins",
"amount": {
"amount": 1.00,
"units": "mins"
}
},
{
"id": "4",
"@baseType": "BucketBalance",
"name": "Free LIME text",
"usageType": "SMS",
"amount": {
"amount": 1.00,
"units": "SMS"
}
},
{
"id": "6",
"@baseType": "BucketBalance",
"name": "Text Messages",
"usageType": "SMS",
"amount": {
"amount": 1.00,
"units": "SMS"
}
},
{
"id": "7",
"@baseType": "BucketBalance",
"name": "Points",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
}
},
{
"id": "8",
"@baseType": "BucketBalance",
"name": "Off Net",
"usageType": "mins",
"amount": {
"amount": 14494.64,
"units": "mins"
}
},
{
"id": "11",
"@baseType": "BucketBalance",
"amount": {
"amount": 0.00
}
},
{
"id": "13",
"@baseType": "BucketBalance",
"name": "Double Bubble Bonus",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
}
},
{
"id": "1",
"@baseType": "BucketBalance",
"name": "primary balance",
"usageType": "Currency",
"amount": {
"amount": 1.00,
"units": "JMD"
}
}
],
"@type": "AccumulatorHistory"
}
]
}
]